<meta charset="UTF-8">
<h1>easy-yapi</h1>
<br/>
<a href="https://github.com/tangcent/easy-yapi">GitHub</a> |
<a href="https://github.com/tangcent/easy-yapi/issues">Issues</a> |
<a href="https://easyyapi.com">Guide</a>
<br/>
<br/>
<b>Help you export API to yapi/postman/markdown</b>
<br/>

<ul>
    <li>Parse API documents based on javadoc & KDoc & ScalaDoc</li>
    <li>Note that you can get a fairly complete API document in the case of zero intrusion of the code.</li>
    <li>However, special requirements still need some special comments/annotations. Compared with this, you can use
        flexible configuration rules to adapt to the characteristics of your project to minimize code intrusion.
    </li>
</ul>
<br/>
<b> Refer to <a href="[https://easyyapi.com ↗](https://easyyapi.com)">Guide</a> for details</b>

<ul>Export API to Yapi/Postman/Markdown:
    <p> Open the file containing <code>api</code> in the project or select the file or folder in the IDE's left project
        file area, use the shortcut <kbd>Alt</kbd> <kbd>Shift</kbd> <kbd>E</kbd> (windows) / <kbd>Ctrl</kbd> <kbd>E</kbd> (mac), Then
        select the API you want to export, select the export channel <code>Yapi/Markdown/Postman</code>, Click the [✔]
        button or press Enter to complete the export.
    </p>
</ul>
<br/>
<p>
    If the shortcut is invalid, please check for shortcut conflicts. You can modify the
    shortcut in <kbd>Preferences(Settings)</kbd> > <kbd>KeyMap</kbd>.
</p>
<br/>